﻿///////////////////////////////////////////////////////////////////////////////
//
// This file is part of the BassDrop project
//   https://code.google.com/p/bass-drop/
//
//
// Creator:	Gergely Krajcsovszki (krajcsovszkig@hotmail.com)
// Date:	2013-08-05 13:05
//
//
// Copyright © 2013-2014. Gergely Krajcsovszki
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
///////////////////////////////////////////////////////////////////////////////
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace BassDrop.Core.Common.Options.Items
{
	/// <summary>
	/// OptionsItem for setting numeric properties via a numericupdown.
	/// </summary>
	public class NumericPropertyOptionsItem : PropertyOptionsItem<double>
	{
		/// <summary>
		/// Minimum allowed value of the property
		/// </summary>
		public double MinValue
		{
			get;
			private set;
		}

		/// <summary>
		/// Maximum allowed value of the property
		/// </summary>
		public double MaxValue
		{
			get;
			private set;
		}

		/// <summary>
		/// Increment/decrement amount with the buttons of the numericupdown in one step
		/// </summary>
		public double Step
		{
			get;
			private set;
		}

		/// <summary>
		/// True if only integer values are allowed
		/// </summary>
		public bool IsInteger
		{
			get;
			private set;
		}

		/// <summary>
		/// Creates a new numeric property setter options item
		/// </summary>
		/// <param name="setAction">Method called when the property value changed.</param>
		/// <param name="getAction">Method called to read the current value of the property from the plugin.</param>
		/// <param name="minValue">Minimum allowed value of the property</param>
		/// <param name="maxValue">Maximum allowed value of the property</param>
		/// <param name="step">Increment/decrement amount with the buttons of the numericupdown in one step</param>
		/// <param name="isInteger">True if only integer values are allowed</param>
		/// <param name="name">Name/title of the item</param>
		/// <param name="description">The description of the item. Shown typically in tooltips</param>
		public NumericPropertyOptionsItem(
			SetActionDelegate setAction,
			GetActionDelegate getAction,
			double minValue,
			double maxValue,
			double step,
			bool isInteger,
			string name,
			string description )
			: base( setAction, getAction, name, description )
		{
			MinValue = minValue;
			MaxValue = maxValue;
			Step = step;
			IsInteger = isInteger;
		}
	}
}
